<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the WaveHeader class from the flutter_sound_helper library, for the Dart programming language.">
  <title>WaveHeader class - flutter_sound_helper library - Dart API</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">
  
  <link rel="stylesheet" href="../static-assets/github.css?v1">
  <link rel="stylesheet" href="../static-assets/styles.css?v1">
  <link rel="icon" href="../static-assets/favicon.png?v1">
  
</head>

<body data-base-href="../" data-using-base-href="false" class="light-theme">
<div id="overlay-under-drawer"></div>
<header id="title">
  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../index.html">flutter_sound</a></li>
    <li><a href="../public_flutter_sound_helper">public&#47;flutter_sound_helper.dart</a></li>
    <li class="self-crumb">WaveHeader class</li>
  </ol>
  <div class="self-name">WaveHeader</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
  <div class="toggle" id="theme-button" title="Toggle brightness">
    <label for="theme">
      <input type="checkbox" id="theme" value="light-theme">
      <span id="dark-theme-button" class="material-symbols-outlined">
        dark_mode
      </span>
      <span id="light-theme-button" class="material-symbols-outlined">
        light_mode
      </span>
    </label>
  </div>
</header>
<main>
<div
    id="dartdoc-main-content"
    class="main-content"
    data-above-sidebar="public_flutter_sound_helper&#47;public_flutter_sound_helper-library-sidebar.html"
    data-below-sidebar="public_flutter_sound_helper&#47;WaveHeader-class-sidebar.html">
    <div>
<h1><span class="kind-class">WaveHeader</span> class 
 
</h1></div>

    
<section class="desc markdown">
  <p>A Wave header.</p>
<hr>
<p>This class represents the header of a WAVE format audio file, which usually
have a .wav suffix.  The following integer valued fields are contained:</p>
<ul>
<li> format - usually PCM, ALAW or ULAW.
</li><li> numChannels - 1 for mono, 2 for stereo.
</li><li> sampleRate - usually 8000, 11025, 16000, 22050, or 44100 hz.
</li><li> bitsPerSample - usually 16 for PCM, 8 for ALAW, or 8 for ULAW.
</li><li> numBytes - size of audio data after this header, in bytes.
</li></ul>
-----------------------------------------------
</section>



    
  <section class="summary offset-anchor" id="constructors">
    <h2>Constructors</h2>
    <dl class="constructor-summary-list">
        <dt id="WaveHeader" class="callable">
          <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/WaveHeader.html">WaveHeader</a></span><span class="signature">(<span class="parameter" id="-param-mFormat"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">mFormat</span>, </span><span class="parameter" id="-param-mNumChannels"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">mNumChannels</span>, </span><span class="parameter" id="-param-mSampleRate"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">mSampleRate</span>, </span><span class="parameter" id="-param-mBitsPerSample"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">mBitsPerSample</span>, </span><span class="parameter" id="-param-mNumBytes"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">mNumBytes</span></span>)</span>
        </dt>
        <dd>
          Construct a WaveHeader, with fields initialized.
        </dd>
    </dl>
  </section>
    
  <section
      class="summary offset-anchor"
      id="instance-properties">
    <h2>Properties</h2>
    <dl class="properties">
        <dt id="hashCode" class="property inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
  

</dt>
<dd class="inherited">
  The hash code for this object.
  <div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>

</dd>

        <dt id="mBitsPerSample" class="property">
  <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/mBitsPerSample.html">mBitsPerSample</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
  

</dt>
<dd>
  
  <div class="features"><span class="feature">getter/setter pair</span></div>

</dd>

        <dt id="mFormat" class="property">
  <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/mFormat.html">mFormat</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
  

</dt>
<dd>
  
  <div class="features"><span class="feature">getter/setter pair</span></div>

</dd>

        <dt id="mNumBytes" class="property">
  <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/mNumBytes.html">mNumBytes</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
  

</dt>
<dd>
  
  <div class="features"><span class="feature">getter/setter pair</span></div>

</dd>

        <dt id="mNumChannels" class="property">
  <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/mNumChannels.html">mNumChannels</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
  

</dt>
<dd>
  
  <div class="features"><span class="feature">getter/setter pair</span></div>

</dd>

        <dt id="mSampleRate" class="property">
  <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/mSampleRate.html">mSampleRate</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
  

</dt>
<dd>
  
  <div class="features"><span class="feature">getter/setter pair</span></div>

</dd>

        <dt id="runtimeType" class="property inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Type-class.html">Type</a></span>
  

</dt>
<dd class="inherited">
  A representation of the runtime type of the object.
  <div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>

</dd>

    </dl>
  </section>

    
  <section
      class="summary offset-anchor"
      id="instance-methods">
    <h2>Methods</h2>
    <dl class="callables">
        <dt id="noSuchMethod" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
    <span class="returntype parameter">&#8594; dynamic</span>
  </span>
  

</dt>
<dd class="inherited">
  Invoked when a nonexistent method or property is accessed.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

        <dt id="toString" class="callable">
  <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/toString.html">toString</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
  </span>
  

</dt>
<dd>
  Push a String info of this header
  <div class="features"><span class="feature">override</span></div>

</dd>

        <dt id="write" class="callable">
  <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/write.html">write</a></span><span class="signature">(<wbr><span class="parameter" id="write-param-out"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-async/EventSink-class.html">EventSink</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>&gt;</span></span>&gt;</span></span> <span class="parameter-name">out</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
  </span>
  

</dt>
<dd>
  Write a WAVE file header.
  

</dd>

    </dl>
  </section>
    
  <section
      class="summary offset-anchor inherited"
      id="operators">
    <h2>Operators</h2>
    <dl class="callables">
        <dt id="operator ==" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a></span> <span class="parameter-name">other</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
  </span>
  

</dt>
<dd class="inherited">
  The equality operator.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

    </dl>
  </section>
    
  <section class="summary offset-anchor" id="static-properties">
    <h2>Static Properties</h2>
    <dl class="properties">
        <dt id="formatALAW" class="property">
  <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/formatALAW.html">formatALAW</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
  

</dt>
<dd>
  Indicates ALAW format.
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="formatFloat" class="property">
  <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/formatFloat.html">formatFloat</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
  

</dt>
<dd>
  Indicates PCM format.
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="formatInt" class="property">
  <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/formatInt.html">formatInt</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
  

</dt>
<dd>
  Indicates PCM format.
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="formatULAW" class="property">
  <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/formatULAW.html">formatULAW</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
  

</dt>
<dd>
  Indicates ULAW format.
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="headerLength" class="property">
  <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/headerLength.html">headerLength</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
  

</dt>
<dd>
  
  <div class="features"><span class="feature">final</span></div>

</dd>

        <dt id="tag" class="property">
  <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/tag.html">tag</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
  

</dt>
<dd>
  follows WAVE format in <a href="http://ccrma.stanford.edu/courses/422/projects/WaveFormat">http://ccrma.stanford.edu/courses/422/projects/WaveFormat</a>
  <div class="features"><span class="feature">final</span></div>

</dd>

    </dl>
  </section>
    
  <section class="summary offset-anchor" id="static-methods">
    <h2>Static Methods</h2>
    <dl class="callables">
        <dt id="writeId" class="callable">
  <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/writeId.html">writeId</a></span><span class="signature">(<wbr><span class="parameter" id="writeId-param-out"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-async/EventSink-class.html">EventSink</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>&gt;</span></span>&gt;</span></span> <span class="parameter-name">out</span>, </span><span class="parameter" id="writeId-param-id"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">id</span></span>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd>
  Push a String to the header
  

</dd>

        <dt id="writeInt16" class="callable">
  <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/writeInt16.html">writeInt16</a></span><span class="signature">(<wbr><span class="parameter" id="writeInt16-param-out"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-async/EventSink-class.html">EventSink</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>&gt;</span></span>&gt;</span></span> <span class="parameter-name">out</span>, </span><span class="parameter" id="writeInt16-param-val"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">val</span></span>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd>
  Push an Int16 in the header
  

</dd>

        <dt id="writeInt32" class="callable">
  <span class="name"><a href="../public_flutter_sound_helper/WaveHeader/writeInt32.html">writeInt32</a></span><span class="signature">(<wbr><span class="parameter" id="writeInt32-param-out"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-async/EventSink-class.html">EventSink</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>&gt;</span></span>&gt;</span></span> <span class="parameter-name">out</span>, </span><span class="parameter" id="writeInt32-param-val"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">val</span></span>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd>
  Push an int32 in the header
  

</dd>

    </dl>
  </section>
    

  </div> <!-- /.main-content -->
  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
<header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
    <li><a href="../index.html">flutter_sound</a></li>
    <li><a href="../public_flutter_sound_helper">flutter_sound_helper</a></li>
    <li class="self-crumb">WaveHeader class</li>
</ol>

    <h5>flutter_sound_helper library</h5>
    <div id="dartdoc-sidebar-left-content"></div>
  </div>
  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
  </div><!--/.sidebar-offcanvas-->
</main>
<footer>
  <span class="no-break">
    flutter_sound
      9.28.0
  </span>
  
</footer>


<script src="../static-assets/highlight.pack.js?v1"></script>
<script src="../static-assets/docs.dart.js"></script>

</body>
</html>

